Skip to content

Comments

Match OSP split#57

Merged
anssiko merged 4 commits intoWICG:mainfrom
backkem:update-openscreen-protocol-references
May 27, 2025
Merged

Match OSP split#57
anssiko merged 4 commits intoWICG:mainfrom
backkem:update-openscreen-protocol-references

Conversation

@backkem
Copy link
Collaborator

@backkem backkem commented May 23, 2025

I asked Jules to rewrite the spec to match the OSP split.

WIP since I still need to review in detail.


Preview | Diff

…n Screen Protocol.

The Open Screen Protocol is now two separate protocols:
- Open Screen Network Protocol (https://www.w3.org/TR/openscreen-network/)
- Open Screen Application Protocol (https://www.w3.org/TR/openscreen-application/)

I've gone through the repository and updated all references from the general "Open Screen Protocol" to the more specific "Open Screen Network Protocol." I also updated all relevant links to point to the new specification URL.

The following files have been updated:
- EXPLAINER.md
- index.bs
- security-privacy-questionnaire.md
@anssiko anssiko requested a review from Copilot May 23, 2025 09:23
@anssiko
Copy link
Member

anssiko commented May 23, 2025

Let's put more agents to work. I just asked Copilot to review this PR from Jules.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@backkem
Copy link
Collaborator Author

backkem commented May 23, 2025

Let's put more agents to work. I just asked Copilot to review this PR from Jules.

I wonder if it'll be able to see the CI error. If so, it may have a chance at fixing it.

@anssiko
Copy link
Member

anssiko commented May 23, 2025

Let's see how far we can go. 😄

I'll ask for Copilot re-review, but let's first give it some more context by asking it for a solution.

Here's the ask:

Please find a solution for failing job 42764191221. Use the logs, job definition, and any referenced files where the failure occurred. Keep your response focused on the solution and include code suggestions when appropriate.

And below is the Copilot's suggested solution to its future self:

The failing job encountered errors related to the Bikeshed build process due to obsolete and ambiguous references in the index.bs file. Here's how to resolve the issue:

Identified Problems

  1. Obsolete Biblio Reference:
  • [openscreenprotocol] is obsolete and replaced by [openscreen-network].
  • The correct reference URL for [openscreen-network] is already defined in the file.
  1. Ambiguous Definition for "allowed to use":
  • The Bikeshed tool detected multiple possible references for "allowed to use."

Solution

  1. Update the Obsolete Reference

Replace all occurrences of [openscreenprotocol] with [openscreen-network]. If this reference is intentionally obsolete, use [openscreenprotocol obsolete].

  1. Resolve the Ambiguous Definition

Add a <pre class="link-defaults"> block to specify the intended reference for "allowed to use." For example:

<pre class="link-defaults">
spec:html; type:dfn; text:allowed to use
</pre>

This ensures that Bikeshed selects the correct definition during the build.

Updated index.bs Changes

16| !openscreenprotocol: https://www.w3.org/TR/openscreen-network/ Open Screen Network Protocol

Replace with:

16| !openscreen-network: https://www.w3.org/TR/openscreen-network/ Open Screen Network

And ensure all instances of [openscreenprotocol] are replaced with [openscreen-network].

Add the following block near the top of the file (after metadata or where appropriate):

<pre class="link-defaults">
spec:html; type:dfn; text:allowed to use
</pre>

Steps to Verify

  1. Apply the changes to the index.bs file.
  2. Rerun the Bikeshed build command:
bikeshed --die-on=warning spec index.bs index.bs.built.html
  1. Push the updated file and trigger the workflow again.

This should resolve the issues and allow the workflow to complete successfully. Let me know if you need further assistance!

@anssiko anssiko requested a review from Copilot May 23, 2025 09:59
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates documentation to match the split of the Open Screen Protocol into the Open Screen Network Protocol.

  • Renames occurrences of “Open Screen Protocol” to “Open Screen Network Protocol”
  • Updates corresponding links in the security/ privacy questionnaire and the explainer

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
security-privacy-questionnaire.md Updated protocol name and link in question 7 and 14
EXPLAINER.md Updated protocol name and link in three sections
Files not reviewed (1)
  • index.bs: Language not supported

@anssiko
Copy link
Member

anssiko commented May 23, 2025

Copilot did not figure out the build is failing, and apparently Bikeshed language is not supported (see Files not reviewed (1)).

I gave it feedback via 👎 that its suggestion did not solve the problem.

Humans are still needed for spec work. 😄

@anssiko
Copy link
Member

anssiko commented May 23, 2025

Perhaps we need to convert the PR to Ready for review to allow Copilot really get to work? Let's try.

@anssiko anssiko marked this pull request as ready for review May 23, 2025 10:15
@anssiko anssiko requested a review from Copilot May 23, 2025 10:15
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates protocol references from "Open Screen Protocol" to "Open Screen Network Protocol" to better reflect the current specifications.

  • Updated protocol name and associated link in the security and privacy questionnaire.
  • Revised protocol references in the explanation document for clarity and consistency.

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.

File Description
security-privacy-questionnaire.md Updated protocol name and link in Q7 and Q14 to match the OSP split requirements.
EXPLAINER.md Revised protocol name and link in multiple sections and adjusted associated descriptive text.
Files not reviewed (1)
  • index.bs: Language not supported
Comments suppressed due to low confidence (1)

security-privacy-questionnaire.md:42

  • The sentence contains a grammatical issue: 'specification' is singular, so 'are to be followed' should be changed to 'is to be followed'.
-    - A: The [specification](https://www.w3.org/TR/openscreen-network/#private-browsing-mode) of the Open Screen Network Protocol are to be followed in this area.

## Solution Approach

The Local Peer-to-Peer API uses the to mutual authentication provided by the Open Screen Protocol to establish mutual TLS certificates between peers. These certificates serve as a trust anchor for secure [local communication](https://wicg.github.io/local-peer-to-peer/#local-communication). The Local Peer-to-Peer specification defines two uses of this new trust anchor:
The Local Peer-to-Peer API uses the to mutual authentication provided by the Open Screen Network Protocol to establish mutual TLS certificates between peers. These certificates serve as a trust anchor for secure [local communication](https://wicg.github.io/local-peer-to-peer/#local-communication). The Local Peer-to-Peer specification defines two uses of this new trust anchor:
Copy link

Copilot AI May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There appears to be an extraneous word 'to' before 'mutual authentication'; consider removing it for clarity.

Copilot uses AI. Check for mistakes.
@anssiko
Copy link
Member

anssiko commented May 23, 2025

OK, let's try one more thing. This is how you fix the build, Copilot:

sed 's/!openscreenprotocol/!openscreen-network/g' index.bs

@anssiko anssiko requested a review from Copilot May 23, 2025 10:39
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates references to the new Open Screen Network Protocol across the specification documents.

  • Updated protocol names and links in security-privacy-questionnaire.md.
  • Updated protocol names, associated links, and reference texts in EXPLAINER.md.

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.

File Description
security-privacy-questionnaire.md Updated protocol name and link for a question and private browsing mode.
EXPLAINER.md Updated protocol name, links, and reference text regarding API authentication.
Files not reviewed (1)
  • index.bs: Language not supported

## Solution Approach

The Local Peer-to-Peer API uses the to mutual authentication provided by the Open Screen Protocol to establish mutual TLS certificates between peers. These certificates serve as a trust anchor for secure [local communication](https://wicg.github.io/local-peer-to-peer/#local-communication). The Local Peer-to-Peer specification defines two uses of this new trust anchor:
The Local Peer-to-Peer API uses the to mutual authentication provided by the Open Screen Network Protocol to establish mutual TLS certificates between peers. These certificates serve as a trust anchor for secure [local communication](https://wicg.github.io/local-peer-to-peer/#local-communication). The Local Peer-to-Peer specification defines two uses of this new trust anchor:
Copy link

Copilot AI May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase 'uses the to mutual authentication' appears to be a typo. Consider revising it to 'uses the mutual authentication' for clarity.

Copilot uses AI. Check for mistakes.
@anssiko
Copy link
Member

anssiko commented May 23, 2025

@backkem, it indeed looks like we still need a human reviewer to fix the build 😄 I'll stop bugging Copilot for now.

This commit removes the <pre class="link-defaults"> block for
"allowed to use" from index.bs, as it was deemed unnecessary.

The biblio updates for "openscreen-network" remain in place.
This commit re-adds the <pre class="link-defaults"> block for
"allowed to use" to index.bs, ensuring it is separated from the
metadata block by a double newline as requested for CI purposes.

The biblio updates for "openscreen-network" remain in place.
@backkem
Copy link
Collaborator Author

backkem commented May 23, 2025

Just sharing learnings if anyone is interested:
Jules was able to follow copilot chat's suggestion 😂. It's just sad that Jules is very slow ATM. Replit agent would have fixed this in seconds, but Jules being able to manage it's own "tasks" is quite handy. I didn't try Codex yet.
I did try "vibe coding" a Go Spake2 implementation in backkem/spake2-go using Replit. It's tantalizingly close but no cigar. I may try to find the time to fix it manually.

@anssiko
Copy link
Member

anssiko commented May 27, 2025

@backkem I reviewer Jules' changes and gave some hints. 🤖

Co-authored-by: Anssi Kostiainen <anssi.kostiainen@intel.com>
@anssiko
Copy link
Member

anssiko commented May 27, 2025

Let's merge this. Copilot found some grammar nits, but better handle those separately. The learning here is Jules needs to read some more Bikeshed docs.

@anssiko anssiko merged commit 9297123 into WICG:main May 27, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants